HERE iOS SDK Developer's Guide

NMAUrbanMobilityDepartureBoardRequest

Class Summary

class NMAUrbanMobilityDepartureBoardRequest

Derived from: NMAUrbanMobilitySearchRequest

Represents a request to retrieve a departure board for the given transit station.

Include: NMAKit.framework/headers/NMAUrbanMobilityDepartureBoardRequest.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAUrbanMobilityDepartureBoardRequest

[For complete information, see the section Class Details]

See also:

NMAUrbanMobilityDepartureBoardCompletionBlock

NMAUrbanMobilityDeparture

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] NSDate *  departureTime

Time which is used as a start point for the departure board being requested

[readable, assign] NMAGeoCoordinates location

Geo coordinates of the station which departure board is being requested

[readable, writable, assign] BOOL  realTimeInfoEnabled

Optional

[readable, assign] NSString *  stationId

The unique ID of the transit station where the departure board is being requested

[readable, writable, assign] NMAUrbanMobilitySearchOption   strictSearch

If set to NMAUrbanMobilitySearchOptionalFlagNo departures from the nearby stations will also be included in the response

[readable, writable, assign] NSSet *  transitModes

Optional

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

-(nonnull instancetype) initWithStationId:(nonnull NSString *) stationId location:(nonnull NMAGeoCoordinates *) location

Creates a new NMAUrbanMobilityDepartureBoardRequest for a departure board at a transit station with a given ID and given geo coordinates

-(BOOL) startWithCompletionBlock:(nonnull NMAUrbanMobilityDepartureBoardCompletionBlock ) completion

Sends the request to retrieve a departure board to the HERE backend server

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Represents a request to retrieve a departure board for the given transit station.

NMAUrbanMobilityDepartureBoardRequest assembles and issues requests to the HERE backend server by providing a station ID, a geo location and some optional properties (such as whether to do a fuzzy search).

The HERE backend server responds with either a list of NMAUrbanMobilityDeparture objects or NSError if something goes wrong. Use NMAUrbanMobilityDepartureBoardCompletionBlock to capture the response.

See also:

NMAUrbanMobilityDepartureBoardCompletionBlock

NMAUrbanMobilityDeparture

Public Property Details

[readable, writable, assign] NSDate * departureTime

Time which is used as a start point for the departure board being requested. All entries in the departure board are the earliest possible departures after the specified time.

Note:

If this property is not set then the current timestamp is used.

[readable, assign] NMAGeoCoordinateslocation

Geo coordinates of the station which departure board is being requested.

[readable, writable, assign] BOOL realTimeInfoEnabled

Optional. Specifies if the real time information will be included in the response. The possible values are: NO – do not include real time information YES – include real time information The default is NO.

[readable, assign] NSString * stationId

The unique ID of the transit station where the departure board is being requested.

[readable, writable, assign] NMAUrbanMobilitySearchOption  strictSearch

If set to NMAUrbanMobilitySearchOptionalFlagNo departures from the nearby stations will also be included in the response.

Note:

The default value is NMAUrbanMobilitySearchOptionUnset which means that it is up to the HERE backend server to decide.

[readable, writable, assign] NSSet * transitModes

See also:

NMAUrbanMobilityTransitMode

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

-(nonnull instancetype) initWithStationId:(nonnull NSString *) stationId location:(nonnull NMAGeoCoordinates *) location

Creates a new NMAUrbanMobilityDepartureBoardRequest for a departure board at a transit station with a given ID and given geo coordinates.

Note:

Both station ID and geo coordinates are required to identify a transit station unambiguously.

Parameters:

  • stationId

    The unique ID of the transit station.

  • location

    Geo coordinates of the transit station.

-(BOOL) startWithCompletionBlock:(nonnull NMAUrbanMobilityDepartureBoardCompletionBlock ) completion

Sends the request to retrieve a departure board to the HERE backend server. Request processing is performed asynchronously: NMAUrbanMobilityDepartureBoardCompletionBlock is used to pass the response.

Note:

NMAUrbanMobilityDepartureBoardCompletionBlock is called on the main queue.

Parameters:

  • completion

    NMAUrbanMobilityDepartureBoardCompletionBlock which is used to pass the response.

Returns:

YES if the request was triggered successfully, NO otherwise.

See also:

NMAUrbanMobilityDepartureBoardCompletionBlock

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly