AWFGeographicObjectLoader Class Reference

Inherits from	AWFObjectLoader : NSObject
Declared in	AWFGeographicObjectLoader.h

Overview

AWFGeographicObjectLoader is a subclass of AWFObjectLoader that provides additional utility methods for requesting API data that is based on a geographic location or region. This class should not be used as is, but rather should be subclassed to provided the required configuration for interacting with the API.

`– getForPlace:options:completion:`

Requests objects for the specific place. The place must be a valid AWFPlace instance.

- (void)getForPlace:(AWFPlace *)place options:(AWFRequestOptions *)options completion:(AWFObjectLoaderCompletionBlock)completionBlock

Parameters

`place`	The place to use for the request.
`options`	An `AWFRequestOptions` instance containing additional parameters to be used with the request (optional).
`completionBlock`	The block to be executed on the completion or failure of a request. This block has no return value and takes two arguments: the array of `AWFObject` instances returned by the request and the error that occurred during the request (if any)

Declared In

AWFGeographicObjectLoader.h

`– getClosestToPlace:radius:options:completion:`

Requests objects within a circle defined by a center at the specific place’s coordinate and a radius. The place must be a valid AWFPlace instance.

- (void)getClosestToPlace:(AWFPlace *)place radius:(NSString *)radius options:(AWFRequestOptions *)options completion:(AWFObjectLoaderCompletionBlock)completionBlock

Parameters

`place`	The place to use for the request.
`radius`	The radius from the place’s coordinate to include results for. Radius should be provided as a valid distance string, (e.g., `@"50mi"` or `@"100km"`). If no radius is provided, the default of `@"25mi"` will be used.
`options`	An `AWFRequestOptions` instance containing additional parameters to be used with the request (optional).
`completionBlock`	The block to be executed on the completion or failure of a request. This block has no return value and takes two arguments: the array of `AWFObject` instances returned by the request and the error that occurred during the request (if any)

Declared In

AWFGeographicObjectLoader.h

`– getWithinBoundsFromNorthwestCoordinate:southeastCoordinate:options:completion:`

Requests objects within a bounding box defined by top-left and bottom-right coordinates.

- (void)getWithinBoundsFromNorthwestCoordinate:(CLLocationCoordinate2D)northwestCoordinate southeastCoordinate:(CLLocationCoordinate2D)southeastCoordinate options:(AWFRequestOptions *)options completion:(AWFObjectLoaderCompletionBlock)completionBlock

Parameters

`northwestCoordinate`	The top-left coordinate of the bounding box
`southeastCoordinate`	The bottom-right coordinate of the bounding box
`options`	An `AWFRequestOptions` instance containing additional parameters to be used with the request (optional).
`completionBlock`	The block to be executed on the completion or failure of a request. This block has no return value and takes two arguments: the array of `AWFObject` instances returned by the request and the error that occurred during the request (if any)

Declared In

AWFGeographicObjectLoader.h

`– getWithinPolygon:options:completion:`

Requests objects within an irregular polygon defined by the a series of coordinates. The specified polygon must be a valid AWFGeoPolygon instance.

- (void)getWithinPolygon:(AWFGeoPolygon *)polygon options:(AWFRequestOptions *)options completion:(AWFObjectLoaderCompletionBlock)completionBlock

Parameters

`polygon`	The polygon
`options`	An `AWFRequestOptions` instance containing additional parameters to be used with the request (optional).
`completionBlock`	The block to be executed on the completion or failure of a request. This block has no return value and takes two arguments: the array of `AWFObject` instances returned by the request and the error that occurred during the request (if any)

Declared In

AWFGeographicObjectLoader.h

`– getContainingPlace:options:completion:`

Requests objects that contain the specified place, if any. This action is normally associated with endpoints that contain polygon data and returns only the objects associated with each polygon that contains the place.

- (void)getContainingPlace:(AWFPlace *)place options:(AWFRequestOptions *)options completion:(AWFObjectLoaderCompletionBlock)completionBlock

Parameters

`place`	The place that must be contain within an object’s polygon
`options`	An `AWFRequestOptions` instance containing additional parameters to be used with the request (optional).
`completionBlock`	The block to be executed on the completion or failure of a request. This block has no return value and takes two arguments: the array of `AWFObject` instances returned by the request and the error that occurred during the request (if any)

Declared In

AWFGeographicObjectLoader.h

`– requestForPlace:options:`

Requests data from the API for the specified place. (Deprecated: As of version 1.2, replaced by ‘getForPlace:options:success:failure:’)

- (void)requestForPlace:(AWFPlace *)place options:(NSDictionary *)options

Parameters

`place`	The `AWFPlace` from which to return data for.
`options`	An optional dictionary containing additional parameters to be used with the request.

Declared In

AWFGeographicObjectLoader.h

`– requestClosest:options:`

Requests data closest to the specified place. (Deprecated: As of version 1.2, replaced by ‘getClosestToPlace:options:success:failure:’)

- (void)requestClosest:(AWFPlace *)place options:(NSDictionary *)options

Parameters

`place`	The `AWFPlace` from which to search for nearby data from.
`options`	An optional dictionary containing additional parameters to be used with the request.

Declared In

AWFGeographicObjectLoader.h

`– requestWithinPolygon:options:`

Requests all data objects within the polygon bounded by the specified points. (Deprecated: As of version 1.2, replaced by ‘getWithinPolygon:options:success:failure:’)

- (void)requestWithinPolygon:(NSArray *)points options:(NSDictionary *)options

Parameters

`points`	An array of coordinate points defining the polygon to search within.
`options`	An optional dictionary containing additional parameters to be used with the request.

Declared In

AWFGeographicObjectLoader.h

`– requestWithinBoundsFromNorthwestCoordinate:southeastCoordinate:options:`

Requests all data objects within the bounding box defined by northwest and southeast coordinate. (Deprecated: As of version 1.2, replaced by ‘getWithinBoundsFromNorthwestCoordinate:southeastCoordinate:options:success:failure:’)

- (void)requestWithinBoundsFromNorthwestCoordinate:(CLLocationCoordinate2D)northwestCoordinate southeastCoordinate:(CLLocationCoordinate2D)southeastCoordinate options:(NSDictionary *)options

Parameters

`northwestCoordinate`	The northwest coordinate, or top-left corner, of the bounding box to search within
`southeastCoordinate`	The southeast coordinate, or bottom-right corner, of the bounding box to search within
`options`	An optional dictionary containing additional parameters to be used with the request.

Declared In

AWFGeographicObjectLoader.h