HERE iOS SDK Developer's Guide

NMAUrbanMobilityMultiBoardRequest

Class Summary

class NMAUrbanMobilityMultiBoardRequest

Derived from: NSObject

Represents a request to retrieve a multi departure board for the given location.

Include: NMAKit.framework/headers/NMAUrbanMobilityMultiBoardRequest.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAUrbanMobilityMultiBoardRequest

[For complete information, see the section Class Details]

See also:

NMAUrbanMobilityMultiBoardCompletionBlock

NMAUrbanMobilityStationWithDepartureBoard

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, assign] NSDate *  departureTime

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

[readable, assign] NMAGeoCoordinates location

Geo coordinates of the location which multi departure board is being requested

[readable, writable, assign] NSUInteger  maxDeparturesPerStation

Optional

[readable, writable, assign] NSUInteger  maximumResults

Optional

[readable, writable, assign] NSInteger  radius

Optional

[readable, writable, assign] BOOL  realTimeInfoEnabled

Optional

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

Specifies a list of station IDs for which we request next departures

[readable, writable, assign] NSSet< NSNumber * > *  transportTypes

Optional

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

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

Creates a new NMAUrbanMobilityMultiBoardRequest for a multi departure board at a transit station with a given geo coordinates

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

Creates a new NMAUrbanMobilityMultiBoardRequest to search only by Station IDs

-(BOOL) startWithCompletionBlock:(nonnull NMAUrbanMobilityMultiBoardCompletionBlock ) completion

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

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Represents a request to retrieve a multi departure board for the given location.

NMAUrbanMobilityMultiBoardRequest assembles and issues requests to the HERE backend server by providing a geo location.

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

See also:

NMAUrbanMobilityMultiBoardCompletionBlock

NMAUrbanMobilityStationWithDepartureBoard

Public Property Details

[readable, writable, assign] NSDate * departureTime

Time which is used as a start point for the multi 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 location which multi departure board is being requested.

[readable, writable, assign] NSUInteger maxDeparturesPerStation

Optional. Specifies the maximum number of next departures per station the response should include. Must be greater than 0.

[readable, writable, assign] NSUInteger maximumResults

Optional. Specifies the maximum number of stations the response should include. Must be greater than 0.

[readable, writable, assign] NSInteger radius

Optional. Specifies a radius in meters that when combined with a centerpoint defines the area of the search. Any value greater than 0 will be added to the request. Otherwise, default value will be used by the backend.

[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] NSArray< NSString * > * stationIds

Specifies a list of station IDs for which we request next departures.

[readable, writable, assign] NSSet< NSNumber * > * transportTypes

See also:

NMAUrbanMobilityTransportType

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

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

Creates a new NMAUrbanMobilityMultiBoardRequest for a multi departure board at a transit station with a given geo coordinates.

Note:

Geo coordinates are required to identify a transit station unambiguously.

Parameters:

  • location

    Geo coordinates of the transit station.

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

Creates a new NMAUrbanMobilityMultiBoardRequest to search only by Station IDs.

Parameters:

  • stationIds

    array of stations IDs. Can't be nil or empty.

-(BOOL) startWithCompletionBlock:(nonnull NMAUrbanMobilityMultiBoardCompletionBlock ) completion

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

Note:

NMAUrbanMobilityMultiBoardCompletionBlock is called on the main queue.

Parameters:

  • completion

    NMAUrbanMobilityMultiBoardCompletionBlock which is used to pass the response.

Returns:

YES if the request was triggered successfully, NO otherwise.

See also:

NMAUrbanMobilityMultiBoardCompletionBlock

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly