AWFTropicalCyclonesArchive

Objective-C

@interface AWFTropicalCyclonesArchive : AWFWeatherEndpoint

Swift

class AWFTropicalCyclonesArchive : AWFWeatherEndpoint

AWFTropicalCyclonesArchive provides convenience methods for interacting with the tropicalcyclones/archive endpoint of the Aeris API. All requests will return instances of AWFTropicalCyclone that will be populated by the data returned by the API unless otherwise indicated.


                    
                    
                    -searchUsingYear:options:completion:

Requests data for the specified tropical season based on a specific search query and request options. This method requires a valid query value on the provided options instance.

Note: If no objects were returned from the request, but the request did not contain any errors, then the completionBlock block will still be executed without errors. Your block handler should verify the total number of objects returned before trying to access them.

Declaration

Objective-C

- (void)searchUsingYear:(NSUInteger)year
                options:(nullable AWFWeatherRequestOptions *)options
             completion:
                 (nonnull AWFWeatherEndpointCompletionBlock)completionBlock;

Swift

func search(usingYear year: UInt, options: AWFWeatherRequestOptions?) async -> AWFWeatherEndpointResult?

Parameters

`year`	The tropical season to search within
`options`	An `AWFWeatherRequestOptions` 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 `AWFWeatherObject` instances returned by the request and the error that occurred during the request (if any)