HERE iOS SDK Developer's Guide

NMAUrbanMobilityStationSearchRequest

Class Summary

class NMAUrbanMobilityStationSearchRequest

Derived from: NMAUrbanMobilitySearchRequest

Represents a request to search for transit station nearby a given location.

Include: NMAKit.framework/headers/NMAUrbanMobilityStationSearchRequest.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAUrbanMobilityStationSearchRequest

[For complete information, see the section Class Details]

See also:

NMAUrbanMobilityStationSearchCompletionBlock

NMAUrbanMobilityStation

NMAUrbanMobilityError

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NMAGeoCoordinates location

Geo coordinates to search for nearby stations around

[readable, writable, assign] NMAUrbanMobilitySearchNameMatchingMethod   nameMatchingMethod

Name matching method defines the fuzziness of the name matching

[readable, writable, assign] BOOL  requestStationDetailsEnabled

Optional parameter

[readable, writable, assign] NSUInteger  searchRange

Range in meters which is used to search for nearby transit stations around a given location

[readable, assign] NSArray< NSString * > *  stationIds

Array of transit station IDs to search for

[readable, writable, assign] NSString *  stationName

Name which is used to match nearby station names

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

-(nonnull instancetype) initWithLocation:(nonnull NMAGeoCoordinates *) location

Creates a new NMAUrbanMobilityStationSearchRequest to search for transit stations around a given location

-(nonnull instancetype) initWithStationIds:(nonnull NSArray< NSString * > *) stationIds

Creates a new NMAUrbanMobilityStationSearchRequest to search for transit stations with given IDs

-(BOOL) startWithCompletionBlock:(nonnull NMAUrbanMobilityStationSearchCompletionBlock ) completion

Sends the request to search for transit stations to the HERE backend server

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Represents a request to search for transit station nearby a given location.

 

See also:

NMAUrbanMobilityStationSearchCompletionBlock

NMAUrbanMobilityStation

NMAUrbanMobilityError

Public Property Details

[readable, assign] NMAGeoCoordinateslocation

Geo coordinates to search for nearby stations around.

Note:

Search range is controlled with searchRange property.

[readable, writable, assign] NMAUrbanMobilitySearchNameMatchingMethod  nameMatchingMethod

Name matching method defines the fuzziness of the name matching. NMAUrbanMobilitySearchNameMatchingMethodStrict means that names must be strictly equal to get matched. NMAUrbanMobilitySearchNameMatchingMethodFuzzy allows some difference between names being matched.

Note:

Default value is NMAUrbanMobilitySearchNameMatchingMethodUnspecified which means that it is up to the HERE backend server to decide.

[readable, writable, assign] BOOL requestStationDetailsEnabled

Optional parameter. Describes whether or not, additional line information for every station is in the response. NO = disabled, YES = enabled The default is YES.

Note:

Parameter is added to request only if client sets value.

[readable, writable, assign] NSUInteger searchRange

Range in meters which is used to search for nearby transit stations around a given location.

Note:

Default value is 0 which means the HERE backend server default.

[readable, assign] NSArray< NSString * > * stationIds

Array of transit station IDs to search for.

Note:

If station ID array is specified then all other request options (e.g. location) will have no effect.

[readable, writable, assign] NSString * stationName

Name which is used to match nearby station names. Matching strictness is controlled by nameMatchingMethod property.

Note:

Default value is the empty string which means that station names are not accounted during the search.

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

-(nonnull instancetype) initWithLocation:(nonnull NMAGeoCoordinates *) location

Creates a new NMAUrbanMobilityStationSearchRequest to search for transit stations around a given location.

Use optional properties to fine tune the search: searchRange, stationName, nameMatchingMethod

Parameters:

  • location

    Geo coordinates to search for nearby transit stations around.

-(nonnull instancetype) initWithStationIds:(nonnull NSArray< NSString * > *) stationIds

Creates a new NMAUrbanMobilityStationSearchRequest to search for transit stations with given IDs.

Parameters:

  • stationIds

    Array of transit station IDs to search for.

-(BOOL) startWithCompletionBlock:(nonnull NMAUrbanMobilityStationSearchCompletionBlock ) completion

Sends the request to search for transit stations to the HERE backend server. Request processing is performed asynchronously: NMAUrbanMobilityStationSearchCompletionBlock is used to pass the response.

Note:

NMAUrbanMobilityStationSearchCompletionBlock is called on the main queue.

Parameters:

  • completion

    NMAUrbanMobilityStationSearchCompletionBlock which is used to pass the response.

Returns:

YES if the request was triggered successfully, NO otherwise.

See also:

NMAUrbanMobilityStationSearchCompletionBlock

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly