HERE iOS SDK Developer's Guide

NMAUrbanMobilityCitySearchRequest

Class Summary

class NMAUrbanMobilityCitySearchRequest

Derived from: NMAUrbanMobilitySearchRequest

Represents a request used for search for public transit coverage by city.

Include: NMAKit.framework/headers/NMAUrbanMobilityCitySearchRequest.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAUrbanMobilityCitySearchRequest

[For complete information, see the section Class Details]

See also:

NMAUrbanMobilityCitySearchCompletionBlock

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] NSInteger  maximumResults

Optional parameter

[readable, writable, assign] BOOL  requestCityDetailsEnabled

Optional parameter

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

-(nonnull instancetype) initWithCity:(nonnull NSString *) cityName

-(BOOL) startWithCompletionBlock:(nonnull NMAUrbanMobilityCitySearchCompletionBlock ) completion

Sends the request to retrieve a public transit coverage by city

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Represents a request used for search for public transit coverage by city.

NMAUrbanMobilityCitySearchRequest assembles and issues requests to the HERE backend server by providing a query string and configuration flag for China.

The HERE backend server responds with a NMAUrbanMobilityCitySearchResult or NSError if something goes wrong. Use NMAUrbanMobilityCitySearchCompletionBlock to capture the response.

See also:

NMAUrbanMobilityCitySearchCompletionBlock

Public Property Details

[readable, writable, assign] NSInteger maximumResults

Optional parameter. Limits the number of cities the response can contain. Default value is 0. Parameter is added to request if it's value is greater than 0.

[readable, writable, assign] BOOL requestCityDetailsEnabled

Optional parameter. Enables Pop (population of a city) and array of NMAUrbanMobilityOperator in the NMAUrbanMobilityCity list. Otherwise, the NMAUrbanMobilityCity doesn't contain that informations. Only applicable for the cities list, the nearby list never contains details NO = disabled, YES = enabled The default is YES. Parameter is added to request only if user sets value.

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

-(nonnull instancetype) initWithCity:(nonnull NSString *) cityName

Creates a new NMAUrbanMobilityCitySearchRequest represents a request used for search public transit coverage by city

Parameters:

  • cityName

    specifies the search text for the city name.

-(BOOL) startWithCompletionBlock:(nonnull NMAUrbanMobilityCitySearchCompletionBlock ) completion

Sends the request to retrieve a public transit coverage by city. Request processing is performed asynchronously: NMAUrbanMobilityCitySearchCompletionBlock is used to pass the response.

Note:

NMAUrbanMobilityCitySearchCompletionBlock is called on the main queue.

Parameters:

  • completion

    NMAUrbanMobilityCitySearchCompletionBlock which is used to pass the response.

Returns:

YES if the request was triggered successfully, NO otherwise.

See also:

NMAUrbanMobilityCitySearchCompletionBlock

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly